Use Arduino Lint to validate releases #18
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
type: enhancement
|
Looks good, I'll wait for it to be updated with the new version of Arduino Lint to approve it. |
|
Something I should mention in case it isn't clear from the code is that part of this proposal is to add the entire text formatted Arduino Lint report to the library's logs web page when linting a release results in an error or warning. So the current logs for Servo look like this: After, will look like this (abnormally long because this is from a local run from scratch, so validating every release, rather than the subsequent logs which would only validate releases not in the index already): |
|
Since the output is very long I think we should put it in a collapsible section like so: Arduino Lint output, click to expand. |
Arduino Lint allows library maintainers to use the same tool locally and in CI as will be used to validate the library submission and its releases. This provides transparency for the whole process and should reduce the Library Manager index support burden.
This functionality is now provided by Arduino Lint.
The Arduino Lint report is shown in the logs whenever a warning or error is encountered while validating a release before adding it to the index. The report is fairly verbose. Putting it in a "details" section allow the reader to get the quick overview of the indexing results that was provided by the previous log format, while also offering the option to get details about the results of the validation.
|
Good idea! I have done it: db141b3 The equivalent to the log above is now: JOB 000 - 2021/05/13 12:00:39 Scraping https://github.com/arduino-libraries/Servo.git JOB 000 - 2021/05/13 12:00:39 Checking out tag: refs/tags/1.0.0 JOB 000 - 2021/05/13 12:00:41 Arduino Lint has suggestions for possible improvements: |
|
Nice. Is it normal tests are failing? 🤔 |
Yes. The problem is that this change is dependent on arduino/arduino-lint#170, but the test workflow installs the release version of Arduino Lint so they don't have access to that new It sounds like we will be able to do a release of Arduino Lint tomorrow. |
|
@silvanocerza now that the 1.1.0 release of Arduino Lint is out, I reran the "Test Go" workflow and it is passing: |
silvanocerza
approved these changes
May 14, 2021
This was referenced May 21, 2021
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Arduino Lint allows library maintainers to use the same tool locally and in CI as will be used to validate the library
submission and its releases. This provides transparency for the whole process and should reduce the Library Manager index
support burden.
Note: This change depends on the addition of a new "indexing" configuration mode to Arduino Lint, which is provided by arduino/arduino-lint#170
So the tests will fail until there has been a release of Arduino Lint. I thought it could be helpful to submit this PR now in order to give the reviewers of arduino/arduino-lint#170 the full picture.